Merged
Conversation
starfy84
force-pushed
the
dx-1580-no-ref-siblings
branch
from
f11c59d to
e5a1b81
Compare
starfy84
force-pushed
the
dx-1580-no-ref-siblings
branch
from
e5a1b81 to
23a0df8
Compare
Fixes the no-$ref-siblings error seen in this [PR](BitGo/dev-portal#2508) Ticket: DX-1580
starfy84
force-pushed
the
dx-1580-no-ref-siblings
branch
from
23a0df8 to
cbe1c86
Compare
starfy84
approved these changes
Jul 29, 2025
ericcrosson-bitgo
approved these changes
Jul 29, 2025
Contributor
ericcrosson-bitgo
left a comment
ericcrosson-bitgo
left a comment
There was a problem hiding this comment.
Alley-oop'ing
Thanks @shenbenson and @starfy84!
|
🎉 This PR is included in version @api-ts/openapi-generator@5.10.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/typed-express-router@2.0.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/express-wrapper@2.0.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the no-$ref-siblings error seen in this PR
Ticket: DX-1580
This is done by wrapping innerSchema
$ref's in anallOfin the case that a ref is present and has siblings.Result:
The following code:
Now results in:
{ openapi: '3.0.3', info: { title: 'Test', version: '1.0.0', }, paths: { '/foo': { get: { summary: 'A simple route with type descriptions for references', operationId: 'api.v1.test', tags: ['Test Routes'], parameters: [], responses: { '200': { description: 'OK', content: { 'application/json': { schema: { $ref: '#/components/schemas/SimpleRouteResponse', }, }, }, }, }, }, }, }, components: { schemas: { SimpleRouteResponse: { description: 'Human readable description of the Simple Route Response', properties: { test: { type: 'array', items: { + allOf: [{ $ref: '#/components/schemas/TestRefBase' }], - $ref: '#/components/schemas/TestRefBase', description: 'List of test refs', }, }, }, required: ['test'], title: 'Human Readable Simple Route Response', type: 'object', }, TestRefBase: { title: 'TestRefBase', type: 'string', }, TestRef: { allOf: [ { title: 'TestRef', }, { $ref: '#/components/schemas/TestRefBase', }, ], }, }, }, }